/*
 * Sonatype Nexus (TM) Open Source Version
 * Copyright (c) 2008-present Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
 * which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
 *
 * Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
 * of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
 * Eclipse Foundation. All other trademarks are the property of their respective owners.
 */
package org.sonatype.nexus.common.entity;

import com.fasterxml.jackson.annotation.JsonIgnore;

/**
 * Mix-in for entities that don't have a natural key and need a generated id.
 *
 * @since 3.19
 */
public interface HasEntityId
{
  EntityId getId();

  void setId(EntityId id);

  /**
   * Entity which should be serialized/deserialized with {@link EntityId} should implement this method.
   *
   * @return {@code true} to allow {@link EntityId} be generated or {@code false} otherwise.
   */
  @JsonIgnore
  default boolean allowGenerate() {
    return true;
  }

  default void clearId() {
    setId(null);
  }
}
